Fix/issue 27 types audit align - #49
Merged
Just-Bamford merged 3 commits intoJul 29, 2026
Merged
Conversation
…nonVote#27) - README: fix stale encryptVote description (base64 -> EncryptedPayload hex object) - README: replace one-line types description with full canonical-source note explaining that AnonVote/core should import from @anonvote/crypto rather than defining local copies in core/shared/ - README: add types table listing all exported types with descriptions - README: update usage example to use EncryptedPayload object for encryptVote/decryptVote (matches actual API from issue AnonVote#39) - README: add DECISIONS.md and client.ts to repo structure diagram - README: add contributor callout directing core away from local type copies Note: ElectionResult, BallotEvent, Token, Vote, AnonVoteCryptoError and all other required types were already added to src/types.ts and fully exported from src/index.ts in the fix/issue-39 branch. No type additions or removals needed — only documentation alignment.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
##closes #27
Changes made to README.md:
Fixed the stale encryptVote row — was still describing base64 colon-delimited output, now correctly describes the EncryptedPayload hex object
Replaced the one-liner types section with a substantive canonical-source statement:
types.ts
is the single source of truth; AnonVote/core should import from @anonvote/crypto instead of defining local copies in core/shared/
Added a types reference table listing all exported types with descriptions
Updated the usage example so encryptVote/decryptVote show the EncryptedPayload object (matches the actual API)
Added DECISIONS.md and client.ts to the repo structure diagram
Added a contributor callout block explicitly directing core away from local type copies
73/73 tests pass, clean tsc build.